docs(agent-readiness): add when-to-use guidance and step-by-step agent auth#639
Conversation
…t auth Addresses the two remaining gaps that are genuinely fixable in this repo: - Identity "when-to-use": add a "When to use Rapidata" section to llms.txt naming best-fit jobs and how an agent should call it. - Access agent-auth warning: add an explicit step-by-step client-credentials flow to the Authentication page and the /developers portal. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Co-Authored-By: lino <lino@rapidata.ai>
Code ReviewThis PR adds two focused documentation improvements for agent readiness: a "When to use Rapidata" section in Findings (most severe first)1. The inline step 4 describes the non-SDK token request as:
This omits -d scope="openid email roles"And the Scopes section explicitly states: "Tokens are scoped. The SDK requests A developer following only the developer portal page will construct an incomplete token request and may receive a token with missing scopes, leading to 2. The new paragraph ends with:
Every other cross-reference in the file uses a full absolute URL (e.g., line 38: Fix: convert to the same Markdown hyperlink format used throughout, or remove the sentence (the content is already covered with proper links in 3. The new
The CLAUDE.md rule is: "not repeat information." The new section adds length without adding facts not already present (with better links) elsewhere in the file. Consider consolidating: the "not the right tool for" exclusions are genuinely new and useful, but the rest is redundant. 4. The "## Get credentials" section directly above the new block says:
Step 1 of the new section says:
These are near-verbatim. Step 1 should reference the preceding section rather than repeat the instruction, e.g.: "1. Complete the steps in Get credentials above." Overall the auth step-by-step is a useful addition and the |
Context
Third pass on orank agent-readiness (now 60/100, grade C, Access at a strong 69/96 after #637 and #638). This PR addresses only the two remaining gaps that are genuinely fixable in this repo — the rest are out of scope by design (see below).
Changes
llms.txt— "When to use Rapidata" (Identity gap: no when-to-use guidance). A specific, non-marketing section naming best-fit jobs (model eval, preference/RLHF datasets, annotation, targeted human feedback), what it's not for, and how an agent should call it (SDK / REST / skill)./developersportal.Gaps I deliberately did NOT chase
I'd flag that we're at the point of diminishing returns for honest docs-repo changes:
rapidata-backend), not docs. The API already returns structured errors; the scanner can't authenticate, so it hits an HTML 404 on the static docs site. Faking JSON errors on a docs host would be meaningless. Worth raising with the gateway/identity team if the API truly returns HTML on some unauthenticated paths.Verification
mkdocs buildpasses; JSON-LD validated;llms.txtcarries the when-to-use section. Takes effect on the next Deploy Documentation run.🔗 Session: https://session-b4f9bfe9.poseidon.rapidata.internal/